Package com.netscape.cms.authentication
Class SessionAuthentication
java.lang.Object
org.dogtagpki.server.authentication.AuthManager
com.netscape.cms.authentication.SessionAuthentication
Pull any existing auth token from the session context.
Use with caution as a profile authenticator; if there is a
session it will unconditionally approve the request
(subject to constraints, etc).
-
Field Summary
Fields inherited from class org.dogtagpki.server.authentication.AuthManager
AUTHENTICATED_NAME, authenticationConfig, CRED_CERT_SERIAL_TO_REVOKE, CRED_CMC_SELF_SIGNED, CRED_CMC_SIGNING_CERT, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT, engine, mConfig, mConfigParams, mImplName, mName
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(AuthCredentials authCred) Authenticate user.Retrieves the localizable name of this policy.String[]
Gets a list of the required credentials for this authentication manager.Retrieves the localizable description of this policy.getValueDescriptor
(Locale locale, String name) Retrieves the descriptor of the given value parameter by name.Retrieves a list of names of the value parameter.void
init
(ConfigStore config) Initializes this default policy.void
init
(AuthenticationConfig authenticationConfig, String instName, String implName, AuthManagerConfig config) Initialize this authentication manager.boolean
Checks if this authenticator requires SSL client authentication.boolean
isValueWriteable
(String name) Checks if the value of the given property should be serializable into the request.void
Populates authentication specific information into the request for auditing purposes.void
shutdown()
prepare this authentication manager for shutdown.Methods inherited from class org.dogtagpki.server.authentication.AuthManager
getAuthenticationConfig, getCMSEngine, getConfigParams, getConfigStore, getImplName, getName, setAuthenticationConfig, setCMSEngine
-
Constructor Details
-
SessionAuthentication
public SessionAuthentication()
-
-
Method Details
-
init
public void init(AuthenticationConfig authenticationConfig, String instName, String implName, AuthManagerConfig config) throws EBaseException Description copied from class:AuthManager
Initialize this authentication manager.- Specified by:
init
in classAuthManager
- Parameters:
instName
- The name of this authentication manager instance.implName
- The name of the authentication manager plugin.config
- The configuration store for this authentication manager.- Throws:
EBaseException
- If an initialization error occurred.
-
isSSLClientRequired
public boolean isSSLClientRequired()Description copied from class:AuthManager
Checks if this authenticator requires SSL client authentication.- Specified by:
isSSLClientRequired
in classAuthManager
- Returns:
- client authentication required or not
-
authenticate
Authenticate user.- Specified by:
authenticate
in classAuthManager
- Parameters:
authCred
- The authentication credentials- Returns:
- the auth token from existing session context, if any.
- Throws:
EMissingCredential
- if no auth token or no session
-
getRequiredCreds
Description copied from class:AuthManager
Gets a list of the required credentials for this authentication manager.- Specified by:
getRequiredCreds
in classAuthManager
- Returns:
- The required credential attributes.
-
shutdown
public void shutdown()prepare this authentication manager for shutdown.- Specified by:
shutdown
in classAuthManager
-
init
Description copied from class:AuthManager
Initializes this default policy.- Specified by:
init
in classAuthManager
- Parameters:
config
- configuration store
-
getName
Retrieves the localizable name of this policy.- Overrides:
getName
in classAuthManager
- Parameters:
locale
- end user locale- Returns:
- localized authenticator name
-
getText
Retrieves the localizable description of this policy.- Specified by:
getText
in classAuthManager
- Parameters:
locale
- end user locale- Returns:
- localized authenticator description
-
getValueNames
Retrieves a list of names of the value parameter.- Specified by:
getValueNames
in classAuthManager
- Returns:
- a list of property names
-
isValueWriteable
Description copied from class:AuthManager
Checks if the value of the given property should be serializable into the request. Passsword or other security-related value may not be desirable for storage.- Specified by:
isValueWriteable
in classAuthManager
- Parameters:
name
- property name- Returns:
- true if the property is not security related
-
getValueDescriptor
Retrieves the descriptor of the given value parameter by name.- Specified by:
getValueDescriptor
in classAuthManager
- Parameters:
locale
- user localename
- property name- Returns:
- descriptor of the requested property
-
populate
Description copied from class:AuthManager
Populates authentication specific information into the request for auditing purposes.- Specified by:
populate
in classAuthManager
- Parameters:
token
- authentication tokenrequest
- request
-